Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add an example demonstrating correct usage of GetUsersPaginated #1201

Merged
merged 2 commits into from
Jul 15, 2024

Conversation

adamrothman
Copy link
Contributor

I had a really hard time finding an example of how (*Client).GetUsersPaginated() is intended to be used. After debugging my own implementation for the better part of a day, I thought it would be nice to add an official example.

@kanata2 kanata2 added example about example codes needs review labels Jun 28, 2023
@lorenzoaiello lorenzoaiello self-assigned this Jul 14, 2024
Copy link
Contributor

@lorenzoaiello lorenzoaiello left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution @adamrothman ! It seems some folks have already benefited from the example and I've validated it locally in my test environment as well.

@lorenzoaiello lorenzoaiello changed the title Add an example demonstrating correct usage of GetUsersPaginated docs: Add an example demonstrating correct usage of GetUsersPaginated Jul 15, 2024
@lorenzoaiello lorenzoaiello merged commit ecfe504 into slack-go:master Jul 15, 2024
6 checks passed
renovate bot added a commit to validator-labs/validator that referenced this pull request Jul 16, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/slack-go/slack](https://togithub.com/slack-go/slack) |
`v0.13.0` -> `v0.13.1` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fslack-go%2fslack/v0.13.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fslack-go%2fslack/v0.13.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fslack-go%2fslack/v0.13.0/v0.13.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fslack-go%2fslack/v0.13.0/v0.13.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>slack-go/slack (github.com/slack-go/slack)</summary>

###
[`v0.13.1`](https://togithub.com/slack-go/slack/releases/tag/v0.13.1)

[Compare
Source](https://togithub.com/slack-go/slack/compare/v0.13.0...v0.13.1)

#### What's Changed

v0.13.1 is now available. It contains **no breaking changes** but does
expose some new fields previously unavailable.

##### Enhancements

- Added `UnfurlLinks` and `UnfurlMedia` to `WebhookMessage` by
[@&#8203;lheiskan](https://togithub.com/lheiskan) in
[slack-go/slack#1208
- Added `isReadOnly` property to `Conversation` struct by
[@&#8203;GGonryun](https://togithub.com/GGonryun) in
[slack-go/slack#1232

##### Bug Fixes

- Fixed `UploadFileV2` when using text content by
[@&#8203;calebmckay](https://togithub.com/calebmckay) in
[slack-go/slack#1291
- Made `Channel` optional on `UploadFileV2` by
[@&#8203;0xdeafcafe](https://togithub.com/0xdeafcafe) in
[slack-go/slack#1293

##### Chores / Code Cleanup

- Replace a Loop with Slice by
[@&#8203;testwill](https://togithub.com/testwill) in
[slack-go/slack#1211
- Added Deprecation Notice for `files.upload` by
[@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) in
[slack-go/slack#1300
- Added Go Test Coverage for 1.21 and 1.22 by
[@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) in
[slack-go/slack#1298

##### Documentation Updates

- Updated Inline Docs and API References by
[@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) in
[slack-go/slack#1299
- Added an example for `Pagination` by
[@&#8203;adamrothman](https://togithub.com/adamrothman) in
[slack-go/slack#1201
- Added an example for `ConversationHistory` by
[@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) in
[slack-go/slack#1302
- Added an example for `AddRemoteFile` and `DeleteFile` by
[@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) in
[slack-go/slack#1303

#### New Contributors

- [@&#8203;calebmckay](https://togithub.com/calebmckay) made their first
contribution in
[slack-go/slack#1291
- [@&#8203;lheiskan](https://togithub.com/lheiskan) made their first
contribution in
[slack-go/slack#1208
- [@&#8203;GGonryun](https://togithub.com/GGonryun) made their first
contribution in
[slack-go/slack#1232
- [@&#8203;0xdeafcafe](https://togithub.com/0xdeafcafe) made their first
contribution in
[slack-go/slack#1293
- [@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) made their
first contribution in
[slack-go/slack#1300
- [@&#8203;adamrothman](https://togithub.com/adamrothman) made their
first contribution in
[slack-go/slack#1201

**Full Changelog**:
slack-go/slack@v0.13.0...v0.13.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/validator-labs/validator).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM3LjQzMS40IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiLCJnbyJdfQ==-->

Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
ymotongpoo pushed a commit to ymotongpoo/opentelemetry-collector-extra that referenced this pull request Aug 13, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/slack-go/slack](https://togithub.com/slack-go/slack) |
`v0.13.0` -> `v0.13.1` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fslack-go%2fslack/v0.13.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fslack-go%2fslack/v0.13.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fslack-go%2fslack/v0.13.0/v0.13.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fslack-go%2fslack/v0.13.0/v0.13.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>slack-go/slack (github.com/slack-go/slack)</summary>

###
[`v0.13.1`](https://togithub.com/slack-go/slack/releases/tag/v0.13.1)

[Compare
Source](https://togithub.com/slack-go/slack/compare/v0.13.0...v0.13.1)

#### What's Changed

v0.13.1 is now available. It contains **no breaking changes** but does
expose some new fields previously unavailable.

##### Enhancements

- Added `UnfurlLinks` and `UnfurlMedia` to `WebhookMessage` by
[@&#8203;lheiskan](https://togithub.com/lheiskan) in
[slack-go/slack#1208
- Added `isReadOnly` property to `Conversation` struct by
[@&#8203;GGonryun](https://togithub.com/GGonryun) in
[slack-go/slack#1232

##### Bug Fixes

- Fixed `UploadFileV2` when using text content by
[@&#8203;calebmckay](https://togithub.com/calebmckay) in
[slack-go/slack#1291
- Made `Channel` optional on `UploadFileV2` by
[@&#8203;0xdeafcafe](https://togithub.com/0xdeafcafe) in
[slack-go/slack#1293

##### Chores / Code Cleanup

- Replace a Loop with Slice by
[@&#8203;testwill](https://togithub.com/testwill) in
[slack-go/slack#1211
- Added Deprecation Notice for `files.upload` by
[@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) in
[slack-go/slack#1300
- Added Go Test Coverage for 1.21 and 1.22 by
[@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) in
[slack-go/slack#1298

##### Documentation Updates

- Updated Inline Docs and API References by
[@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) in
[slack-go/slack#1299
- Added an example for `Pagination` by
[@&#8203;adamrothman](https://togithub.com/adamrothman) in
[slack-go/slack#1201
- Added an example for `ConversationHistory` by
[@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) in
[slack-go/slack#1302
- Added an example for `AddRemoteFile` and `DeleteFile` by
[@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) in
[slack-go/slack#1303

#### New Contributors

- [@&#8203;calebmckay](https://togithub.com/calebmckay) made their first
contribution in
[slack-go/slack#1291
- [@&#8203;lheiskan](https://togithub.com/lheiskan) made their first
contribution in
[slack-go/slack#1208
- [@&#8203;GGonryun](https://togithub.com/GGonryun) made their first
contribution in
[slack-go/slack#1232
- [@&#8203;0xdeafcafe](https://togithub.com/0xdeafcafe) made their first
contribution in
[slack-go/slack#1293
- [@&#8203;lorenzoaiello](https://togithub.com/lorenzoaiello) made their
first contribution in
[slack-go/slack#1300
- [@&#8203;adamrothman](https://togithub.com/adamrothman) made their
first contribution in
[slack-go/slack#1201

**Full Changelog**:
slack-go/slack@v0.13.0...v0.13.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View the
[repository job
log](https://developer.mend.io/github/ymotongpoo/opentelemetry-collector-extra).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM3LjQzOC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
example about example codes Web API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants